home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfrgstr.zip / SFRGSTR.DOC < prev    next >
Text File  |  1990-12-31  |  13KB  |  246 lines
  1.  
  2.  
  3.                               SFRGSTR.EXE
  4.                           A Spitfire! Utility
  5.                       for Registration Management.
  6.  
  7.                              Co-Authored by
  8.  
  9.                              Craig S. Brown
  10.                                   and
  11.                             Charles P. Hosey
  12.  
  13.                                    of
  14.                      CraB Programming Laboratories.
  15.                         Hattiesburg, Mississippi
  16.                         
  17.                               BBS Numbers:
  18.  
  19.                               Craig Brown
  20.                                (Iron Paw)
  21.                       Citadel BBS:  (601) 264-0539
  22.  
  23.                               Chuck Hosey
  24.                  Prometheus Design BBS:  (601) 264-0589
  25.  
  26. INTRODUCTION
  27. -----------------------------------------------------------------------
  28.     CraB Programming Laboratories has been programming professionally 
  29. since 1989.  Recently, We saw a need to move into the ShareWare market 
  30. with software of the quality of the professional markets.  We have 
  31. decided to start with Bulletin Board software.
  32.     We hope that the software provided will be useful and easy to use, 
  33. while being powerful enough to meet your needs.  With your help and 
  34. input, we can produce software that is especially suited to the needs 
  35. of BBS SysOp's everywhere.
  36.     Spitfire! is a registered trademark of Mike Woltz, the author of 
  37. this fine program.  Special thanks go to Mike for putting up with the 
  38. phone calls and messages necessary to get this and other programs off 
  39. the ground.  From us at CraB Programming Labs, "Thanks Mike, and we 
  40. look forward to doing more business with you in the future!"
  41.  
  42. SYNAPSIS
  43. -----------------------------------------------------------------------
  44.     SFRGSTR.EXE is a dual purpose program.  It runs as a stand alone 
  45. program to allow the SysOp of a Spitfire! BBS to register and manage 
  46. users who are on a time-based registration.  It also runs as an event, 
  47. doing the necessary management for the SysOp, freeing him or her to 
  48. spend their time on more important things, like deciding who is the 
  49. sexiest user on the system!
  50.     We sincerely hope that this program will help you to control your 
  51. users situation, and free your time.
  52.  
  53. INFORMATION
  54. -----------------------------------------------------------------------
  55.     SFRGSTR.EXE was written in Turbo Pascal 5.5 (a product of Borland 
  56. International) and is specifically designed for Spitfire! BBS.  It will 
  57. NOT work with any other BBS program that we know of.  It allows 
  58. registration of users in years (in the range of 0 to 100 years), a 
  59. change in security upon registration, and a change of security upon 
  60. expiration.  If a user renews registration, it allows the extension of 
  61. a registration period. 
  62.     SFRGSTR.EXE is menu driven from the command level, and is fairly 
  63. straightforward.  Commands will be discussed in the section labeled 
  64. COMMANDS.  Later additions will contain more SFUSERS.DAT handling 
  65. utilities, but for now, it only allows for registration, changing 
  66. registrations, killing registrations, and search routines by user name 
  67. and number.
  68.     In the event mode, SFRGSTR.EXE will search all registered users for 
  69. expiration and will expire and change security levels for any user who 
  70. has passed their expiration date.  In addition, it will send a warning 
  71. to any user who has come within one calander month of his expiration 
  72. date ONCE and once only.  This is accomplished through the use of 
  73. <usernum>.BBS. 
  74.     The file handling of SFRGSTR.EXE is somewhat slow, but the speed 
  75. was traded for security.  If power fails during execution, some or all 
  76. of the changes to be made will already be on the disk, and thus less 
  77. time is required to restore the lost data.  
  78.     Your SFUSERS.DAT is automatically backed to USERBACK.CPL upon 
  79. execution and usually renaming this file to SFUSERS.DAT and re-running 
  80. the program is all that is necessary for crash-recovery.
  81.  
  82.  
  83. NECESSARY FILES
  84. -----------------------------------------------------------------------
  85.     Included in the package should be:
  86.          SFRGSTR.EXE    -  The executable program
  87.          REGISTER.DAT   -  The file of registered users
  88.          WARNING.CPL    -  Text file, this is written to <username>.BBS
  89.                            and may be edited by any standard text
  90.                            editor.  Do not use an editor that will
  91.                            embed control charachters, as it may result
  92.                            in garbled displays or system crash.
  93.          SFRGSTR.DOC    -  This file.  Since you are reading it, I will
  94.                            assume that you have it.
  95.          ORDER.CPL      -  This is the Order form to get a registered
  96.                            copy of SFRGSTR.EXE.
  97.  
  98. RUNNING SFRGSTR.EXE
  99. -----------------------------------------------------------------------
  100.     To run SFRGSTR, SFRGSTR.EXE, REGISTER.DAT, and WARNING.CPL must be 
  101. copied into your work directory.  Without this, the program will fail 
  102. to run properly.
  103.     There are two modes in which SFRGSTR.EXE may be run.  Local (used by 
  104. SysOp to subscribe users) and Event (used to maintain registered users).
  105.  
  106.     LOCALLY:
  107.               SFRGSTR.EXE may be run locally by simply typing
  108.          SFRGSTR.EXE at the DOS prompt.  For more information on
  109.          the commands listed on the menu, see section COMMANDS.
  110.  
  111.     EVENT:
  112.               To run SFRGSTR.EXE as an event, command line parameters
  113.          are necessary.  The structure is such:
  114.  
  115.  
  116.               SFRGSTR         /E        10         C:\SF\DISPLAY
  117.                  |             |         |                |
  118.                Program name    |         |                |
  119.                                |         |                |
  120.                            Run event     |                |
  121.                    (not case sensitivve) |                |
  122.                                          |                |
  123.                                  Expired security level   |
  124.                                                           |
  125.                                                Path to display files
  126.  
  127.  
  128.               Note:  Expired security level is the security level that
  129.          you want a user to become when their registration is up.
  130.  
  131.  
  132.               For example:  If you want your users to become level 25
  133.          when they allow their registration to lapse, and your display
  134.          files path is 'd:\spitfire\display' the command line would be:
  135.  
  136.          SFRGSTR /E 25 D:\SPITFIRE\DISPLAY
  137.  
  138.          Please note that upper and lower case are not distinguished.
  139.               /E is the same as /e.
  140.  
  141. DISPLAY
  142. -----------------------------------------------------------------------
  143.     The display is simple and straightforward.  In the event mode, it 
  144. simply lists the users who are subscribed with a message "Checking 
  145. user:".  This is simply so that if you are watching, you may see the 
  146. program as it works.
  147.     In local mode, the screen is divided into two sections.  The top of 
  148. the screen displays the stats of the current user.  The bottom section 
  149. of the screen lists the commands that are available to you.  For more 
  150. information on those commands, see the section labeled COMMANDS.
  151.  
  152. COMMANDS
  153. -----------------------------------------------------------------------
  154.     When SFRGSTR is run as an event, there is only a message as to 
  155. whose security levels are being checked.  There are no commands at this 
  156. point as it was intended to run without supervision.
  157.     When SFRGSTR is run locally, however, a list of commands are 
  158. displayed, and a prompt asks you for your choice.  These commands are 
  159. now discussed in detail.  (Allright!  What you've been waiting for!)
  160.  
  161.     F)ind user . . . . . This feature works just like the Find User
  162.                          option in Spitfire! Sysop Utilities.  When
  163.                          you press F, a prompt appears asking you for
  164.                          the UserName.  Type in the first AND last
  165.                          names of the user you wish to edit.  The
  166.                          program will find the user you typed in. 
  167.                          If the name you typed was not a user of your 
  168.                          BBS, then the last user record will be
  169.                          displayed on the screen, otherwise, the user's
  170.                          stats will be displayed.
  171.  
  172.     U)ser Number . . . . This will allow you to jump to the record
  173.                          corresponding to User Number.  When you press
  174.                          U, a prompt will appear asking you for a user
  175.                          number.  Enter in the appropriate number and
  176.                          press enter.  The system will jump to the user
  177.                          associated with the number you entered.  If a
  178.                          number larger than the number of users on your
  179.                          system is entered, the system will jump to the
  180.                          last user on the system.
  181.  
  182.     S)uscribe user . . . This will subscribe the user whose stats are
  183.                          displayed at the top of the screen.  When 'S'
  184.                          is pressed, you will be prompted for the users
  185.                          new security level.  Enter the correct level
  186.                          and press enter.  Then you will be prompted
  187.                          for the subscription length (in years).  Enter
  188.                          the number of years and press enter.  The
  189.                          screen wil update to show the new information,
  190.                          and the subscription date will be set to the
  191.                          system date.
  192.  
  193.     K)ill subscription . This will remove the displayed users file from
  194.                          the registration file, and optionally change 
  195.                          the security level of the user.  When this is
  196.                          selected, you are prompted for a new security
  197.                          level.  Type new level and press enter.  The
  198.                          display will be refreshed to show the changes.
  199.  
  200.  
  201.     C)hange Subscription This allows you to change a users subscription
  202.                          length and/or security level.  When chosen, a
  203.                          prompt asks you for the new security level.
  204.                          After entering the new security level, you
  205.                          will be prompted for the length of the
  206.                          subscription.  Note that this is in years from
  207.                          the Subscription date listed at the top right-
  208.                          hand corner of the screen, not from the
  209.                          present date.
  210.  
  211.     X)it to DOS  . . . . This allows you to exit to DOS.  At the prompt
  212.                          respond with either a Y or N.  The standard
  213.                          exit routine, as if the program is amazed that
  214.                          you would ever be willing to quit!
  215.  
  216. Well, that about sums it up for now.  Later, more options will be 
  217. added, and these will be made available to registered users through 
  218. Citadel BBS (601) 264-0539 and The Prometheus Design BBS (601) 264-0589
  219. free of charge.  Please register this software, it is what allows us
  220. to continue to bring you useful programs at these prices.
  221.  
  222. NOTICE
  223. -----------------------------------------------------------------------
  224.     This program is shareware, NOT freeware.  It is copyrighted by CraB
  225. Programming Laboratories.  Continued use of this program is considered 
  226. acceptance of its usefulness, and therefore registration is required.
  227. Of course, if you don't register it, nothing bad will happen, and it is 
  228. most likely that we will never catch you, but as the subscription is 
  229. only $5, please think about it, it will get you free updates, and our 
  230. undying gratification.  Also, technical support will be available 
  231. through either of the BBS's listed on the front page of this manual.
  232.  
  233. DISCLAIMER
  234. -----------------------------------------------------------------------
  235.     CraB Programming Laboratories, Craig Brown, and Chuck Hosey are not 
  236. responsible for any damage that may occur through the use, misuse, or 
  237. inability to use this program, whether your fault or ours.  Sorry, 
  238. guys, but I gotta do this.
  239.  
  240. FINALE
  241. -----------------------------------------------------------------------
  242.     This program may be distributed freely, as long as no fee is 
  243. charged for its distribution, and the program or corresponding files 
  244. are not edited or changed in any way.
  245.  
  246.